Skip to main content
Plugins / Reviewdog ESLint

Reviewdog ESLint

by Woodpecker Authors

plugin to do code review using ESLint using Woodpecker CI pull request builds


Woodpecker CI plugin check code with ESLint and report results as Pull Request code review using Reviewdog.

Features

  • Automatically detect Forge platform and URL
  • Support multiple forges - Gitea, Forgejo, Github, Gitlab

Settings

Settings Name Default Description
token none sets Forge API token for
patterns . list of file patterns to run eslint on
extensions none eslintrc Mode Only. list of file extensions to lint
config none sets the custom configuration file path to use
no-config false eslintrc Mode Only. sets to not use configuation file
ignore-path .eslintignore or .gitignore eslintrc Mode Only. path to pattern ignore file
ignore-patterns none list of file patterns to exclude from linting

Advanced settings

Settings Name Default Description
debug false enable debug mode
tool-name - custom tool name to report

Examples

  review:
    image: woodpeckerci/plugin-reviewdog-eslint
    settings:
      token:
        from_secret: botuser_token
    when:
      event: pull_request